Skip to content

Adjust README position#2885

Merged
RobbieTheWagner merged 1 commit intomainfrom
readme-to-root
Jan 14, 2026
Merged

Adjust README position#2885
RobbieTheWagner merged 1 commit intomainfrom
readme-to-root

Conversation

@RobbieTheWagner
Copy link
Member

@RobbieTheWagner RobbieTheWagner commented Jan 14, 2026 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Chores
    • Updated build configuration and package manifest to include README documentation in the npm package distribution.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 14, 2026 •
edited
Loading

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request adjusts how the README.md file is distributed in the shepherd project. The build script now copies README.md to the project root instead of the dist directory, the published npm package includes README.md in its files array, and git configuration ignores the copied README at the root level.

Changes

Cohort / File(s) Summary
Build and Package Configuration
.gitignore, package.json, projects/shepherd/package.json		 Modified build_lib script to copy README.md to projects/shepherd/ instead of projects/shepherd/dist/; added README.md to the npm publish files array in projects/shepherd/package.json; added gitignore rule for projects/shepherd/README.md

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • More release-plan tweaks #2877: Both PRs modify packaging and README handling for projects/shepherd, including build script adjustments, package.json files array updates, and README placement changes.

Poem

🐰 A README finds its rightful place,
No longer lost in dist's dark space,
Published proud, yet git-ignored with grace,
The shepherd's tale now ships with style and pace! 📚✨

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c467f01 and b001f74.

📒 Files selected for processing (3)
  • .gitignore
  • package.json
  • projects/shepherd/package.json

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@RobbieTheWagner RobbieTheWagner merged commit f933487 into main Jan 14, 2026
4 of 5 checks passed
@RobbieTheWagner RobbieTheWagner deleted the readme-to-root branch January 14, 2026 18:33
@github-actions github-actions bot mentioned this pull request Jan 14, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

internal

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@RobbieTheWagner